Hybris UX Api

List & Retrieve Logical Resource

List Logical Resource:

1. List Available ESIM(ICCID) Numbers (Prepaid & Postpaid)
2. List Available Service(MSISDN) Numbers (Prepaid & Postpaid)

Retrieve Logical Resource:

1. Retrieve Status of ESIM(ICCID) Numbers
2. Retrieve Status of Service(MSISDN) Numbers

URL

https://[host]:[port]/ecom-ux/v1/{businessId}/logicalResource
https://[host]:[port]/ecom-ux/v1/{businessId}/logicalResource/{id}

URL PARAMS

Headers

Query Params

Data Model

Response Headers

Data Model Response

resourceCharacteristic subResource -Data Model

resourceCharacteristic[].name=='PortDetails' subResource - Data Model

Keyconsiderations

GET/logicalResource

PA Implementation

MSISDN Usecase

**POSTPAID**
- For MSISDN usecase applicable queryParams are: @type, place.id, resourceStatus, value.
- To retrieve available service numbers (MSISDN), set '@type' to "MSISDN" and pass valid place.id value.
- To retrieve reserved service numbers (MSISDN), set 'resourceStatus" to 'reserved' and pass valid MSISDN number in 'value' field.
- To get available service numbers 'resourceStatus' queryparam is optional.
- To get available serviceNumbers (MSISDN), refer to below sample example:
  response - "PA_listAvailable_serviceNumber_Response" in API specification

**PREPAID**
- For MSISDN usecase applicable queryParams are: resourceStatus, resourceCharacteristic.name, resourceCharacteristic.value, limit.
- To retrieve available MSISDN numbers, set the resourceStatus to "Active".
- If we need to retrieve 'PREPAID' MSISDN numbers we need to pass resourceCharacteristic.name == "SERVICE" and resourceCharacteristic.value == "PREPAID".
- limit should be mandatory and greater than or equals to 1.
- The list of resourceCharacteristics in the response varies based on the userDataType, userDataValue fields retrieved in userDataList from TNM system response.

ESIM Usecase

 - This is implemented for mobile postpaid & prepaid customers
 - For ESIM usecase applicable queryParams are: @type, resourceStatus, relatedParty.id,  relatedParty.role, resourceCharacteristic.name, resourceCharacteristic.value, limit.
 - To retrieve available eSIM numbers (ICCID), set '@type' to "ESIM".
 - relatedParty[].id and relatedParty[].role are mandatory fields when '@type' equals to "ESIM".
 - To retrieve available eSIM numbers (ICCID), set the resourceStatus to "available".This queryparam is optional, By default value "available" will be set.
 - If we need to retrieve 'POSTPAID' eSIM numbers we need to pass resourceCharacteristic.name == "SERVICE" and resourceCharacteristic.value == "POSTPAID" else available eSIM numbers will be returned.
 - If we need to retrieve 'PREPAID' eSIM numbers we need to pass resourceCharacteristic.name == "SERVICE" and resourceCharacteristic.value == "PREPAID" else available eSIM numbers will be returned.
 - limit should be mandatory and greater than or equals to 1
 - Dealer Code Configuration:
          * Dealer code defines the pool of eSIMs allocated to each channel.
          * Business must decide the dealer code.
          * TNM must configure it for:
                 -> eCommerce – dealer code: "ECOM"
                 -> Super App – dealer code: TBD
 - In Response these fields are mandatory - ResourceStatus, KI, IMSI,ICCID, PIN1, PUK1, PIN2, PUK2,ACTIVATION-CODE, SIM-TYPE,PREPAID-DEALER.
 - To get available eSIM (ICCID), refer to below sample example:
  response - "PA_listAvailable_eSIMNumber_Response" in API specification

Liberty Caribbean Markets Implementation

MSISDN Usecase

- This is implemented for postpaid customers for JM market.
- Mandatory queryParams to retrieve available MSISDN: @type, place.id.
    - set '@type' queryParam to "MSISDN" and pass valid place identifier for place.id.
    - Optional queryParam: 'resourceStatus', If passed then value need to be set to 'available'.
- We will get a Minimum of 1 to Maximum of 20 available service numbers from Liberate.
- Refer to below sample example for get available service numbers:
  response - "JM_listAvailable_serviceNumber_Response" in API specification

ICCID Usecase

- This is implemented for postpaid customers for JM market.
- Mandatory queryParams to retrieve available ICCID: @type, resourceCharacteristic.name, resourceCharacteristic.value.
   - set '@type' queryParam to "ESIM"
   - To retrieve POSTPAID ICCID we need to pass resourceCharacteristic.name == "SERVICE" and resourceCharacteristic.value == "POSTPAID".
- Liberate will return only one ICCID number at a time.

Note : For response examples please refer to this URL Get LogicalResource Specification

GET/logicalResource/{id}

PA Implementation

MSISDN & ESIM Usecase

**PREPAID**

- For MSISDN usecase applicable queryParams are: '@type'.
- Expected values for '@type' are : 'ESIM' or 'MSISDN'.
- In response 'resourceStatus' is mandatory to identify the state of ESIM(ICCID) or Service(MSISDN) Number.

Note : For response examples please refer to this URL Get LogicalResource By Id Specification